home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat4 / pmview+.z / pmview+
Encoding:
Text File  |  2001-04-17  |  39.8 KB  |  793 lines

  1.  
  2.  
  3.  
  4. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmvvvviiiieeeewwww++++ - configuration file format for performance metrics 3D
  10.      visualization back-end
  11.  
  12. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  13.      This man page describes version 2.1 of ppppmmmmvvvviiiieeeewwww++++ configuration file format,
  14.      which is the extention of ppppmmmmvvvviiiieeeewwww(1) configuration format version 2.1.
  15.  
  16.      The configuration format supports metrics from multiple hosts or
  17.      archives.  A configuration file can specify metrics without a source,
  18.      with different hosts and different archives.  However, a configuration
  19.      file that contains archives may only have one archive for anyone host.
  20.      When in ``replay'' mode, any metrics with host specific sources require
  21.      an archive to be specified for that host on the command line or as a
  22.      source to a previous metric.  The archive must be the same archive (based
  23.      on a string comparison of the archive names) of any archives specified in
  24.      the configuration file for the same host.
  25.  
  26.      The time controls will list all hosts that are specified on the command
  27.      line and the configuration file in the timezone listing (see ppppmmmmttttiiiimmmmeeee(1)).
  28.  
  29.      The configuration file format is based on a two-dimensional grid which
  30.      can contain a variety of bars, stacks, links, pipes, labels and other
  31.      grids.  The grids resize each column and row to match the size of the
  32.      largest item in that column or row.  A configuration file that contains
  33.      only one object does not require a grid. The ppppmmmmvvvviiiieeeewwww++++ configuration file
  34.      starts with an identification header in the first non-comment line:
  35.  
  36.           pmview Version 2.1 [_c_o_m_m_a_n_d__l_i_n_e]
  37.  
  38.      The optional _c_o_m_m_a_n_d__l_i_n_e should be the command line with which the tool
  39.      was launched, if the configuration file has been generated by another
  40.      tool.  This is useful for applications that are to be restarted
  41.      automatically on the next login, after the user has logged out while
  42.      ppppmmmmvvvviiiieeeewwww++++ was still running.  Care should be taken to ensure that the
  43.      command specified is either a full pathname or will be found on the PATH
  44.      available at login.
  45.  
  46.      All lines which begin with ``#'' are treated as comments and ignored.
  47.      Otherwise, all spaces, tabs and newlines are treated as white space so
  48.      multiple commands may be on the same line.
  49.  
  50.      The syntax for specifying values in the configuration file is consistent
  51.      for all commands, namely:
  52.  
  53.      _c_o_l_o_r
  54.          A color must be either a XXXX(1) color name, a XXXX(1) numerical color, or
  55.          three normalized _r_e_a_l values representing the saturation of red,
  56.          green and blue.  For example, the following colors are identical:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  71.  
  72.  
  73.  
  74.                red
  75.                rgbi:1.0/0.0/0.0
  76.                1.0 0.0 0.0
  77.  
  78.      _i_n_t An integer.
  79.  
  80.      _m_e_t_r_i_c
  81.          A metric consists of an optional source (host or archive), the metric
  82.          name, an optional instance list immediately after name, followed by
  83.          the maximum (or normalization value).  A colon (``:'') is used to
  84.          separate a host name from the metric, and a forward slash (``/'') to
  85.          separate an archive name from the metric.  Instances are enclosed in
  86.          square brackets and comma separated.  Each instance may be enclosed
  87.          in quotes.
  88.  
  89.          For example, some legal metrics are:
  90.  
  91.                kernel.all.cpu.idle 4000
  92.                myhost:kernel.all.cpu.idle[cpu0,"cpu3"] 1000.0
  93.                /path/to/myarchive/kernel.all.cpu.idle[cpu1] 1000
  94.  
  95.          To assist the process of matching instance names, two further
  96.          comparisons are made beyond a simple string comparison.  If the
  97.          instance name contains spaces, only the first word in the instance
  98.          name is required to match the instance, assuming that the first word
  99.          is unique.  If the first word is not unique, only the first matching
  100.          instance will be selected.  The second comparison occurs if the first
  101.          word is a number with leading zeros.  Any leading zeros will be
  102.          skipped before comparing the first word again.  This permits process
  103.          ids used in the _p_r_o_c metrics to be easily matched, without specifying
  104.          the entire instance name.  For example, to visualize the user and
  105.          system time of _i_n_i_t use the metric specification
  106.  
  107.                proc.psusage.utime[1]    1000
  108.                proc.psusage.stime[1]    1000
  109.  
  110.      _n_a_m_e
  111.          A name for an object which may be referred to later in the
  112.          configuration file.  Names must be a single word consisting of all
  113.          alphanumeric characters, as well as underscores, dashes and colons.
  114.          It is recommended that names do not begin with an underscore as this
  115.          may be interpreted as a keyword.
  116.  
  117.      _p_o_s This is the position of the object within the grid.  The syntax of a
  118.          position is:
  119.  
  120.  
  121.           [ [_x _z] [ [_w_i_d_t_h _d_e_p_t_h] [_a_l_i_g_n_m_e_n_t] ] ]
  122.  
  123.             _x      The horizontal coordinate (left to right) of the object,
  124.                    starting at 0.  The default _x is 0.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  137.  
  138.  
  139.  
  140.             _z      The vertical coordinate (top to bottom) of the object,
  141.                    starting at 0.  The default _z is 0.
  142.  
  143.             _w_i_d_t_h  The number of columns occupied by the object.  The default
  144.                    _w_i_d_t_h is 1.
  145.  
  146.             _d_e_p_t_h  The number of rows occupied by the object.  The default
  147.                    _d_e_p_t_h is 1.
  148.  
  149.             _a_l_i_g_n_m_e_n_t
  150.                    The edge or corner that the object is aligned with.
  151.                    Possible alignments include: _n_o_r_t_h, _s_o_u_t_h, _e_a_s_t, _w_e_s_t,
  152.                    _n_o_r_t_h_e_a_s_t, _n_o_r_t_h_w_e_s_t, _s_o_u_t_h_e_a_s_t, _s_o_u_t_h_w_e_s_t and _c_e_n_t_e_r.
  153.                    Abbreviations like _s_e and _S_E are also accepted.  The
  154.                    default alignment is _c_e_n_t_e_r.
  155.  
  156.                    The size of an object may not be known as the number of
  157.                    instances for some metrics will vary between hosts and PMDA
  158.                    configurations.  Therefore, the position of the object can
  159.                    be used to specify the likely size of the object, so that
  160.                    the position of the surrounding objects is appropriately
  161.                    adjusted.
  162.  
  163.                    The following are legal positions:
  164.  
  165.                    0 5    The object is centered at grid position 0,5
  166.                           occupying 1 grid square.
  167.  
  168.                    1 2 north
  169.                           The object is aligned with the north edge of
  170.                           position 1,2 occupying 1 grid square.
  171.  
  172.                    2 2 2 1 east
  173.                           The object is aligned to the eastern edge of
  174.                           position 3,2 and occupies 2 grid squares (2,2 and
  175.                           3,2).
  176.  
  177.      _s_t_r_i_n_g
  178.          A string is a series of characters enclosed in double quotes.  A
  179.          string may not contain newlines or escaped double quotes.
  180.  
  181.  
  182.      There are several parameters that may affect the size, shape and color of
  183.      objects when they are displayed.  These parameters are scoped so that
  184.      they only alter objects defined later in the same scope.  Therefore,
  185.      parameter settings at the top of a configuration file affect the entire
  186.      scene, unless they are changed later in the file.  Most of these
  187.      parameters are also resources.
  188.  
  189.      ____bbbbaaaarrrrLLLLeeeennnnggggtttthhhh _i_n_t
  190.          The side length of the ____bbbbaaaarrrr and ____ssssttttaaaacccckkkk blocks.  Default is 28.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  203.  
  204.  
  205.  
  206.      ____bbbbaaaarrrrHHHHeeeeiiiigggghhhhtttt _i_n_t
  207.          The maximum height of a ____bbbbaaaarrrr and ____ssssttttaaaacccckkkk blocks.  Default is 80.
  208.  
  209.      ____bbbbaaaasssseeeeCCCCoooolllloooorrrr _c_o_l_o_r
  210.          The color of ____bbbbaaaarrrr, ____ggggrrrriiiidddd and ____ssssttttaaaacccckkkk base planes.  Default is
  211.          rgbi:0.15/0.15/0.15.
  212.  
  213.      ____bbbbaaaasssseeeeHHHHeeeeiiiigggghhhhtttt _i_n_t
  214.          The height of ____bbbbaaaarrrr, ____ggggrrrriiiidddd and ____ssssttttaaaacccckkkk base planes.  Default is 2.
  215.  
  216.      ____ggggaaaappppWWWWiiiiddddtttthhhh _i_n_t
  217.          The gap between blocks in a ____bbbbaaaarrrr object in the X-axis.  The default
  218.          is 8.
  219.  
  220.      ____ggggaaaappppDDDDeeeepppptttthhhh _i_n_t
  221.          The gap between blocks in a ____bbbbaaaarrrr object in the Z-axis.  The default
  222.          is 8.
  223.  
  224.      ____ggggaaaappppLLLLaaaabbbbeeeellll _i_n_t
  225.          The gap between the base of a ____bbbbaaaarrrr object, and any metric or instance
  226.          labels.  The default is 6.
  227.  
  228.      ____ggggrrrriiiiddddWWWWiiiiddddtttthhhh _i_n_t
  229.          The minimum width of a ____ggggrrrriiiidddd column.  The default is 20.
  230.  
  231.      ____ggggrrrriiiiddddDDDDeeeepppptttthhhh _i_n_t
  232.          The minimum depth of a ____ggggrrrriiiidddd row.  The default is 20.
  233.  
  234.      ____llllaaaabbbbeeeellllMMMMaaaarrrrggggiiiinnnn _i_n_t
  235.          The margin around a ____llllaaaabbbbeeeellll object.  The default is 5.
  236.  
  237.      ____llllaaaabbbbeeeellllCCCCoooolllloooorrrr _c_o_l_o_r
  238.          The color of ____llllaaaabbbbeeeellll and ____bbbbaaaarrrr labels.  The default is white.
  239.  
  240.      ____mmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh _i_n_t
  241.          The extra width of a ____bbbbaaaarrrr, ____ggggrrrriiiidddd and ____ssssttttaaaacccckkkk base plane beyond the
  242.          objects on the plane.  The default is 8.
  243.  
  244.      ____mmmmaaaarrrrggggiiiinnnnDDDDeeeepppptttthhhh _i_n_t
  245.          The extra depth of a ____bbbbaaaarrrr, ____ggggrrrriiiidddd and ____ssssttttaaaacccckkkk base plane beyond the
  246.          objects on the plane.  The default is 8.
  247.  
  248.      ____ppppiiiippppeeeeLLLLeeeennnnggggtttthhhh _i_n_t
  249.          Total length of a ____ppppiiiippppeeee....  The default is the value of ____bbbbaaaarrrrHHHHeeeeiiiigggghhhhtttt....
  250.  
  251.      ____ssssccccaaaalllleeee _r_e_a_l
  252.          The scale applied to the entire scene.  This parameter may not be
  253.          used within any objects, only at the top of the configuration file.
  254.          The default is 1.0.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  269.  
  270.  
  271.  
  272.      To simplify the specification of colors, a ____ccccoooolllloooorrrrLLLLiiiisssstttt and a ____ccccoooolllloooorrrrSSSSccccaaaalllleeee
  273.      may be used to define colors for an object which has metrics associated
  274.      with it, i.e. ____bbbbaaaarrrr, ____ssssttttaaaacccckkkk or ____ppppiiiippppeeee.  A color list may be defined within
  275.      an object, or named and defined at the top of a configuration file.  A
  276.      named color list may then be referenced within multiple objects:
  277.  
  278.      ____ccccoooolllloooorrrrLLLLiiiisssstttt _n_a_m_e (((( _c_o_l_o_r [_c_o_l_o_r...] ))))
  279.          Associate the _c_o_l_o_rs with the color list _n_a_m_e.  The assignment of
  280.          colors to blocks depends on the type of an object.  For example, the
  281.          color list called _f_o_o has the same color three times:
  282.  
  283.          _colorList foo ( red rgbi:1.0/0.0/0.0 1.0 0.0 0.0 )
  284.  
  285.  
  286.      ____ccccoooolllloooorrrrSSSSccccaaaalllleeee _n_a_m_e _c_o_l_o_r (((( _c_o_l_o_r _r_e_a_l [_c_o_l_o_r _r_e_a_l...] ))))
  287.          Associate the _c_o_l_o_rs and _r_e_a_ls with the color list _n_a_m_e.  The initial
  288.          _c_o_l_o_r is the default color of the object.  The object will change
  289.          color to the other colors when the normalized value of the object is
  290.          equal to or greater than each _r_e_a_l.  Therefore, each _r_e_a_l must be
  291.          larger than the previous _r_e_a_l, and should be in the range 0.0 to 1.0.
  292.          This scale gradually changes from blue to red:
  293.  
  294.          _colorScale coldToHot blue ( rgbi:0.5/0.0/1.0 0.3
  295.                                       purple 0.6
  296.                                       rgbi:1.0/0.0/0.5 0.8
  297.                                       red 0.95)
  298.  
  299.      There are several different object types which could be found in a
  300.      ppppmmmmvvvviiiieeeewwww++++ scene: ____bbbbaaaarrrr, ____ssssttttaaaacccckkkk, ____ppppiiiippppeeee, ____ggggrrrriiiidddd, ____lllliiiinnnnkkkk, and ____llllaaaabbbbeeeellll.  There is
  301.      also ____xxxxiiiinnnngggg which is a special type of the ____lllliiiinnnnkkkk.  The ____bbbbaaaarrrr, ____ssssttttaaaacccckkkk and
  302.      ____ppppiiiippppeeee objects are modulated by metric values, a ____llllaaaabbbbeeeellll is fixed text,
  303.      ____lllliiiinnnnkkkk and ____xxxxiiiinnnngggg are interconnects and a ____ggggrrrriiiidddd is a container of objects,
  304.      including other ____ggggrrrriiiidddd objects, which controls the layout of the scene.  A
  305.      ____ggggrrrriiiidddd object is only required if there are two or more objects in the
  306.      scene.
  307.  
  308.      ____bbbbaaaarrrr, ____ggggrrrriiiidddd and ____ssssttttaaaacccckkkk objects may have base planes which provide a point
  309.      of reference for the blocks as they change height.  A label can be
  310.      applied to the base plane ____ggggrrrriiiidddd object if it is ____sssshhhhoooowwwwnnnn with:
  311.  
  312.                ____bbbbaaaasssseeeeLLLLaaaabbbbeeeellll _n_a_m_e|_s_t_r_i_n_g
  313.  
  314.      ____bbbbaaaasssseeeeLLLLaaaabbbbeeeellll should be used within the scope of the relevant ____bbbbaaaarrrr, ____ggggrrrriiiidddd or
  315.      ____ssssttttaaaacccckkkk object.  The first ``\n'' characters in the string will be
  316.      replaced by a new line.  Subsequent ``\n'' characters will be ignored.
  317.  
  318.      For a scene to be valid it must contain at least one modulated object.
  319.  
  320.      The objects are defined as:
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  335.  
  336.  
  337.  
  338.      ____bbbbaaaarrrr [_o_p_t_i_o_n_s] (((( [_m_e_t_r_i_c-_l_i_s_t] [_c_o_l_o_r-_l_i_s_t] [_l_a_b_e_l-_l_i_s_t] ))))
  339.          A ____bbbbaaaarrrr object represents a collection of blocks.  The number of
  340.          blocks depends on the number of metrics and metric instances assigned
  341.          to the object.  By default, the blocks are modulated by changing the
  342.          height of each block.  Alternatively, blocks may be modulated by
  343.          changing color, or both height and color.  Each color in the _c_o_l_o_r-
  344.          _l_i_s_t is assigned to each metric.  Therefore, multiple instances of
  345.          the one metric will have the same color.  The _o_p_t_i_o_n_s that may be
  346.          passed to a ____bbbbaaaarrrr object are:
  347.  
  348.          _p_o_s The position of the ____bbbbaaaarrrr object within the current ____ggggrrrriiiidddd object.
  349.  
  350.          ____ccccoooollll|____rrrroooowwww
  351.              Position the blocks so that each instance is in a column (____ccccoooollll)
  352.              or a row (____rrrroooowwww).  This implies that each different metric is in a
  353.              separate row or column, respectively.  The default is ____ccccoooollll.
  354.  
  355.          ____sssshhhhoooowwww|____hhhhiiiiddddeeee
  356.              Is the base plane visible? Default is ____sssshhhhoooowwww.
  357.  
  358.          ____yyyymmmmoooodddd|____ccccoooolllloooorrrrmmmmoooodddd|____ccccoooolllloooorrrryyyymmmmoooodddd
  359.              Modulate the blocks by adjusting their height (____yyyymmmmoooodddd), color
  360.              (____ccccoooolllloooorrrrmmmmoooodddd) or both height and color (____ccccoooolllloooorrrryyyymmmmoooodddd).
  361.  
  362.          ____ccccuuuubbbbeeee|____ccccyyyylllliiiinnnnddddeeeerrrr
  363.              Set the shape of the blocks.  The default is ____ccccuuuubbbbeeee.
  364.  
  365.          ____ggggrrrroooouuuuppppbbbbyyyymmmmeeeettttrrrriiiicccc|____ggggrrrroooouuuuppppbbbbyyyyiiiinnnnsssstttt|____ggggrrrroooouuuuppppbbbbyyyyrrrroooowwww|||||ggggrrrroooouuuuppppbbbbyyyyccccoooollll
  366.              Set the grouping of blocks when launching other tools. For tools
  367.              like ppppmmmmcccchhhhaaaarrrrtttt(1) some views may generate many small charts which
  368.              cannot be drawn entirely within the screen.  Another problem is
  369.              it may be more appropriate to generate charts with the same
  370.              instance in each chart, rather then the same metric.  The group
  371.              specifiers control the algorithm used so that a separate chart
  372.              will be drawn for each ____mmmmeeeettttrrrriiiiccccssss specification (____ggggrrrroooouuuuppppbbbbyyyymmmmeeeettttrrrriiiicccc),
  373.              for the first, second etc. instance of each ____mmmmeeeettttrrrriiiicccc
  374.              (____ggggrrrroooouuuuppppbbbbyyyyiiiinnnnsssstttt), or by the rows and columns of the ____bbbbaaaarrrr object
  375.              depending on ____rrrroooowwww or ____ccccoooollll.  The default is ____ggggrrrroooouuuuppppbbbbyyyymmmmeeeettttrrrriiiicccc.
  376.  
  377.          The options must be specified in this order, although preceding
  378.          options are not required.  Therefore, this is legal:
  379.  
  380.                _bar _hide _cylinder ( ... )
  381.  
  382.          The metrics, colors and labels are specified within the brackets in
  383.          any order.  Only the _m_e_t_r_i_c-_l_i_s_t is mandatory.
  384.  
  385.          _m_e_t_r_i_c-_l_i_s_t
  386.              A ____bbbbaaaarrrr metric list contains a list of metric names, normalization
  387.              values and an optional label for the metric:
  388.  
  389.              ____mmmmeeeettttrrrriiiiccccssss (((( _m_e_t_r_i_c _r_e_a_l [_s_t_r_i_n_g] [_m_e_t_r_i_c _r_e_a_l [_s_t_r_i_n_g]...] ))))
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  401.  
  402.  
  403.  
  404.          _c_o_l_o_r-_l_i_s_t
  405.              A ____bbbbaaaarrrr color list may be a named color list that was defined
  406.              earlier, or an unnamed color list.  A ____ccccoooolllloooorrrrSSSSccccaaaalllleeee list should be
  407.              used when using ____ccccoooolllloooorrrrmmmmoooodddd or ____ccccoooolllloooorrrryyyymmmmoooodddd modulation.  Therefore,
  408.              the syntax for color lists within a ____bbbbaaaarrrr object are any of:
  409.  
  410.              ____ccccoooolllloooorrrrLLLLiiiisssstttt _n_a_m_e
  411.              ____ccccoooolllloooorrrrLLLLiiiisssstttt (((( _c_o_l_o_r [_c_o_l_o_r...] ))))
  412.              ____ccccoooolllloooorrrrSSSSccccaaaalllleeee _n_a_m_e
  413.              ____ccccoooolllloooorrrrSSSSccccaaaalllleeee _c_o_l_o_r (((( _c_o_l_o_r _r_e_a_l [_c_o_l_o_r _r_e_a_l...] ))))
  414.  
  415.          _l_a_b_e_l-_l_i_s_t
  416.              In addition to labels for each metric in the _m_e_t_r_i_c-_l_i_s_t, metric
  417.              and instance labels may be defined using ____mmmmeeeettttrrrriiiiccccllllaaaabbbbeeeellllssss and
  418.              ____iiiinnnnssssttttllllaaaabbbbeeeellllssss statements.  The position of the labels around the
  419.              ____bbbbaaaarrrr object depends on the ____rrrroooowwww or ____ccccoooollll orientation of metrics
  420.              and instances, and whether the label is read ____ttttoooowwwwaaaarrrrddddssss the ____bbbbaaaarrrr
  421.              object, or ____aaaawwwwaaaayyyy.  The default is ____ttttoooowwwwaaaarrrrddddssss.
  422.  
  423.              ____mmmmeeeettttrrrriiiiccccllllaaaabbbbeeeellllssss [____aaaawwwwaaaayyyy|____ttttoooowwwwaaaarrrrddddssss] (((( _n_a_m_e|_s_t_r_i_n_g [_n_a_m_e|_s_t_r_i_n_g...] ))))
  424.              ____iiiinnnnssssttttllllaaaabbbbeeeellllssss [____aaaawwwwaaaayyyy|____ttttoooowwwwaaaarrrrddddssss] (((( _n_a_m_e|_s_t_r_i_n_g
  425.              [_n_a_m_e|_s_t_r_i_n_g...] ))))
  426.  
  427.  
  428.      ____ggggrrrriiiidddd [_p_o_s] [____sssshhhhoooowwww|____hhhhiiiiddddeeee] (((( _o_b_j_e_c_t_s ))))
  429.          A ____ggggrrrriiiidddd object is a container for objects, including other ____ggggrrrriiiidddd
  430.          objects.  The rows and columns of a ____ggggrrrriiiidddd object are resized to the
  431.          largest object in the row or column.  If an object spans multiple
  432.          rows and/or columns, those rows and columns may be partly resized to
  433.          contain the object.  However, the resizing of rows and columns for
  434.          objects occupying multiple rows and columns occurs after resizing for
  435.          objects occupying only one grid square.
  436.  
  437.          A collision between objects occupying the same squares will be
  438.          reported as an error message and the later object will be ignored.
  439.  
  440.          The options to a ____ggggrrrriiiidddd object control the position (_p_o_s) of the ____ggggrrrriiiidddd
  441.          object in the parent ____ggggrrrriiiidddd, and indicate whether to ____sssshhhhoooowwww or ____hhhhiiiiddddeeee
  442.          the ____ggggrrrriiiidddd base plane.  By default, the base plane is hidden.
  443.  
  444.          The parameters described above may be specified within the brackets
  445.          of a ____ggggrrrriiiidddd object, however they only apply to the objects within the
  446.          ____ggggrrrriiiidddd, not the ____ggggrrrriiiidddd itself.  For a parameter to be applied to a
  447.          ____ggggrrrriiiidddd object, it must be specified before the ____ggggrrrriiiidddd object
  448.          declaration.
  449.  
  450.  
  451.      ____llllaaaabbbbeeeellll [_o_p_t_i_o_n_s] _s_t_r_i_n_g
  452.          A ____llllaaaabbbbeeeellll object draws the contexts of _s_t_r_i_n_g at the location,
  453.          orientation and size specified in the _o_p_t_i_o_n_s:
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                                                         PPPPaaaaggggeeee 7777
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  467.  
  468.  
  469.  
  470.          _p_o_s The position of the ____llllaaaabbbbeeeellll object in the current ____ggggrrrriiiidddd object.
  471.  
  472.          ____lllleeeefffftttt|____rrrriiiigggghhhhtttt|____uuuupppp|____ddddoooowwwwnnnn
  473.              The orientation of the _s_t_r_i_n_g.  The direction indicates the
  474.              direction the label is read.  Therefore, ____rrrriiiigggghhhhtttt is the default
  475.              since the string is read from left to right.
  476.  
  477.          ____ssssmmmmaaaallllllll|____mmmmeeeeddddiiiiuuuummmm|____llllaaaarrrrggggeeee
  478.              The font size.  The default is ____mmmmeeeeddddiiiiuuuummmm.
  479.  
  480.  
  481.      ____lllliiiinnnnkkkk _p_o_s [_s_t_r_i_n_g]
  482.          A ____lllliiiinnnnkkkk object draws a straight or L-shaped horizontal round ``pipe''
  483.          with diameter equal to 80% of the __b_a_s_e_H_e_i_g_h_t of an enclosing ____ggggrrrriiiidddd.
  484.          The properties of the object are defined by the options:
  485.  
  486.  
  487.          _p_o_s sets both the position of the ____lllliiiinnnnkkkk on the grid and its shape.
  488.              ____lllliiiinnnnkkkk starts in the column and row on the ____ggggrrrriiiidddd specified by
  489.              first two numbers in the _p_o_s and spans the number of columns and
  490.              rows set by the second two numbers. The _a_l_i_g_n_m_e_n_t value is used
  491.              to decide the orientation of the link (links are always aligned
  492.              at the center):  _e_a_s_t and _w_e_s_t links are straight and going from
  493.              left to right, _n_o_r_t_h and _s_o_u_t_h links are straight and going from
  494.              far end of the grid to near end, _n_o_r_t_h_e_a_s_t, _n_o_r_t_h_w_e_s_t, _s_o_u_t_h_e_a_s_t
  495.              and _s_o_u_t_h_w_e_s_t links are L-shaped and connect the corresponding
  496.              points of the compass, i.e. a _n_o_r_t_h_e_a_s_t link takes on the general
  497.              shape of the Latin letter ``L''.
  498.  
  499.          _s_t_r_i_n_g
  500.              sets the ``tag'' for the ____lllliiiinnnnkkkk which will be displayed in the
  501.              text window when the pointer is over the link.
  502.  
  503.  
  504.  
  505.      ____ppppiiiippppeeee _p_o_s (((( [_m_e_t_r_i_c-_l_i_s_t] [_c_o_l_o_r-_l_i_s_t] [_t_a_g] ))))
  506.          A ____ppppiiiippppeeee object represent a set of cylinders, placed on top of each
  507.          other and oriented parallel to the base plane. The diameter of a
  508.          ____ppppiiiippppeeee is equal to 80% of __b_a_s_e_H_e_i_g_h_t.  The number of blocks is
  509.          dependent on the number of metric instances in the _m_e_t_r_i_c-_l_i_s_t.  The
  510.          colors in the _c_o_l_o_r-_l_i_s_t are assigned in turn to each cylinder in the
  511.          ____ppppiiiippppeeee.  The length of the ____ppppiiiippppeeee is defined by the __p_i_p_e_L_e_n_g_t_h.
  512.  
  513.  
  514.          _p_o_s defines the position of the ____ppppiiiippppeeee on the enclosing ____ggggrrrriiiidddd and its
  515.              orientation with _a_l_i_g_n_m_e_n_t field used to define at which end of
  516.              the pipe to stack the colored cylinders. The cylinders are
  517.              stacked at the corresponding point of the compass and the pipe's
  518.              direction is from the point of the compass towards the center of
  519.              the compass. Only _e_a_s_t, _w_e_s_t, _n_o_r_t_h, and _s_o_u_t_h are valid values
  520.              for the pipe's alignment.
  521.  
  522.  
  523.  
  524.  
  525.                                                                         PPPPaaaaggggeeee 8888
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  533.  
  534.  
  535.  
  536.      The metrics, colors and label may be specified within the brackets in any
  537.      order.  Only the _m_e_t_r_i_c-_l_i_s_t is mandatory.
  538.  
  539.      _m_e_t_r_i_c-_l_i_s_t
  540.          A ____ppppiiiippppeeee metric list contains a list of metric names and normalization
  541.          values:
  542.  
  543.          ____mmmmeeeettttrrrriiiiccccssss (((( _m_e_t_r_i_c _r_e_a_l [_m_e_t_r_i_c _r_e_a_l...] ))))
  544.  
  545.  
  546.      _c_o_l_o_r-_l_i_s_t
  547.          A ____ppppiiiippppeeee color list may be named color list that was defined earlier,
  548.          or an unnamed color list:
  549.  
  550.          ____ccccoooolllloooorrrrLLLLiiiisssstttt _n_a_m_e
  551.          ____ccccoooolllloooorrrrLLLLiiiisssstttt (((( _c_o_l_o_r [_c_o_l_o_r...] ))))
  552.  
  553.  
  554.      _t_a_g A ____ppppiiiippppeeee may have a ``tag'' for the filler block (unanimated block on
  555.          the ``other'' end of the pipe) which will be displayed in the text
  556.          window when the pointer is over that end of the pipe.
  557.  
  558.          ____ppppiiiippppeeeeTTTTaaaagggg _n_a_m_e|_s_t_r_i_n_g
  559.  
  560.  
  561.      ____ssssttttaaaacccckkkk [_o_p_t_i_o_n_s] (((( [_m_e_t_r_i_c-_l_i_s_t] [_c_o_l_o_r-_l_i_s_t] [_l_a_b_e_l] ))))
  562.          A ____ssssttttaaaacccckkkk object represents a set of blocks placed vertically on top
  563.          of each other.  The number of blocks is dependent on the number of
  564.          metric instances in the _m_e_t_r_i_c-_l_i_s_t.  The colors in the _c_o_l_o_r-_l_i_s_t
  565.          are assigned to each block in the ____ssssttttaaaacccckkkk.  By default, the height of
  566.          the ____ssssttttaaaacccckkkk will be the sum of the height of each block.  The _o_p_t_i_o_n_s
  567.          that may be passed to a ____ssssttttaaaacccckkkk object are:
  568.  
  569.          _p_o_s The position of the ____ssssttttaaaacccckkkk object within the current ____ggggrrrriiiidddd
  570.              object.
  571.  
  572.          ____sssshhhhoooowwww|____hhhhiiiiddddeeee
  573.              Is the base plane visible? Default is ____sssshhhhoooowwww.
  574.  
  575.          ____uuuuttttiiiillllmmmmoooodddd|____ffffiiiillllllllmmmmoooodddd
  576.              Force the height of the stack to always be the maximum height.
  577.              This is achieved by normalizing the height of each block
  578.              (____uuuuttttiiiillllmmmmoooodddd), or by adding a grey block to the top of the stack
  579.              (____ffffiiiillllllllmmmmoooodddd).
  580.  
  581.          ____ccccuuuubbbbeeee|____ccccyyyylllliiiinnnnddddeeeerrrr
  582.              Set the shape of the blocks.  The default is ____ccccuuuubbbbeeee.
  583.  
  584.          The options must be specified in this order, although preceding
  585.          options are not required.  Therefore, this is legal:
  586.  
  587.                _stack 1 1 _north _utilmod ( ... )
  588.  
  589.  
  590.  
  591.                                                                         PPPPaaaaggggeeee 9999
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  599.  
  600.  
  601.  
  602.          The metrics, colors and label may be specified within the brackets in
  603.          any order.  Only the _m_e_t_r_i_c-_l_i_s_t is mandatory.
  604.  
  605.          _m_e_t_r_i_c-_l_i_s_t
  606.              A ____ssssttttaaaacccckkkk metric list contains a list of metric names and
  607.              normalization values:
  608.  
  609.              ____mmmmeeeettttrrrriiiiccccssss (((( _m_e_t_r_i_c _r_e_a_l [_m_e_t_r_i_c _r_e_a_l...] ))))
  610.  
  611.  
  612.          _c_o_l_o_r-_l_i_s_t
  613.              A ____ssssttttaaaacccckkkk color list may be named color list that was defined
  614.              earlier, or an unnamed color list:
  615.  
  616.              ____ccccoooolllloooorrrrLLLLiiiisssstttt _n_a_m_e
  617.              ____ccccoooolllloooorrrrLLLLiiiisssstttt (((( _c_o_l_o_r [_c_o_l_o_r...] ))))
  618.  
  619.  
  620.          _l_a_b_e_l
  621.              A ____ffffiiiillllllllmmmmoooodddd type ____ssssttttaaaacccckkkk may have a label for the filler block:
  622.  
  623.              ____ssssttttaaaacccckkkkLLLLaaaabbbbeeeellll _n_a_m_e|_s_t_r_i_n_g
  624.  
  625.  
  626.      ____xxxxiiiinnnngggg _c_o_l _r_o_w _c_o_l_u_m_n_s _r_o_w_s _d_i_r_1 ... _d_i_r_4
  627.          A ____xxxxiiiinnnngggg is a special kind of link which is used to draw a pair of
  628.          links which cross each other. To convey the visual impression that
  629.          the links do not join, one of the links is drawn as a ``broken''
  630.          cylinder.  _c_o_l and _r_o_w define the position on the enclosing grid.
  631.          _c_o_l_u_m_n_s and _r_o_w_s define the size of the bounding box. The end points
  632.          of the crossing cylinders are placed exactly in the center of the
  633.          corner cells of the bounding box and four small cylinders or stubs
  634.          are used to join the perimeter of the bounding box with the end
  635.          points on the crossing cylinders. Four _d_i_r values define the
  636.          orientation of the stubs, starting at the upper left corner of the
  637.          ____xxxxiiiinnnngggg and proceeding clockwise, such that respective stubs are used
  638.          to join the point of the compass with the center on the cell (see
  639.          example).
  640.  
  641. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  642.      This simple example illustrates the use of parameters and different
  643.      object types:
  644.  
  645.           pmview Version 2.1
  646.           # Use a lighter grey for the base planes
  647.           _baseColor rgbi:0.5/0.5/0.5
  648.  
  649.           # Define colors for CPU object
  650.           _colorList cpu ( blue2 red2 yellow2 cyan2 green2 )
  651.  
  652.           # The top grid object, but hide it from view
  653.           _grid _hide (
  654.  
  655.  
  656.  
  657.                                                                        PPPPaaaaggggeeee 11110000
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  665.  
  666.  
  667.  
  668.           # Show the current load in a bar object
  669.              _bar 0 0 (
  670.                  _baseLabel "Load averages over a\n1, 5 and 15 minute interval"
  671.                  _metrics (
  672.                     kernel.all.load[1] 1 "1"
  673.                     kernel.all.load[5] 1 "5"
  674.                     kernel.all.load[15] 1 "15"
  675.                )
  676.                _colorList ( blue blue blue )
  677.               )
  678.  
  679.           # Add a label below the load bars
  680.               _label 0 1 "Load"
  681.  
  682.           # Change the color of the base plane for later objects
  683.               _baseColor pink
  684.  
  685.           # Show the CPU usage over all CPUs in a utilization stack
  686.               _stack 2 0 _south _utilmod (
  687.                _baseLabel "CPU Utilization over all CPUs"
  688.                _metrics (
  689.                     kernel.all.cpu.user 1000
  690.                     kernel.all.cpu.sys 1000
  691.                     kernel.all.cpu.intr 1000
  692.                     kernel.all.cpu.wait.total 1000
  693.                     kernel.all.cpu.idle 1000
  694.                )
  695.                _colorList cpu
  696.               )
  697.  
  698.           # Add a label below the CPU stack
  699.               _label 2 1 "CPU"
  700.  
  701.           # Create a separate grid for links and pipes
  702.               _marginWidth 1
  703.               _marginDepth 1
  704.               _gridSpace  12
  705.               _grid 0 3 5 4 _hide (
  706.                _pipeLength 12
  707.                _baseHeight 12
  708.  
  709.                # Add  a pipe and a link with western orientation
  710.                _pipe 0 0 west (
  711.                    _pipeTag "West pipe"
  712.                    _metrics (
  713.                     kernel.all.cpu.user 1000
  714.                     kernel.all.cpu.sys 1000
  715.                     kernel.all.cpu.idle 1000
  716.                    )
  717.                    _colorList cpu
  718.                )
  719.  
  720.  
  721.  
  722.  
  723.                                                                        PPPPaaaaggggeeee 11111111
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730. PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))                                                          PPPPMMMMVVVVIIIIEEEEWWWW++++((((4444))))
  731.  
  732.  
  733.  
  734.               _link 0 2 west "West link"
  735.  
  736.                # Add xing
  737.                _xing 1 0 3 3 west east east west
  738.  
  739.                # Add a link and a pipe with eastern orientation
  740.                _pipe 4 0 east (
  741.                    _pipeTag "East Pipe"
  742.                    _metrics (
  743.                     kernel.all.cpu.user 1000
  744.                     kernel.all.cpu.sys 1000
  745.                     kernel.all.cpu.idle 1000
  746.                    )
  747.                    _colorList cpu
  748.                )
  749.                _link 4 2 east "East link"
  750.               )
  751.           )
  752.  
  753. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  754.      ppppmmmmvvvviiiieeeewwww(1) and ppppmmmmvvvviiiieeeewwww++++(1).
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.                                                                        PPPPaaaaggggeeee 11112222
  790.  
  791.  
  792.  
  793.